<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>12.6. anydbm — Generic access to DBM-style databases &mdash; Python v2.6.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '2.6.2',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Python v2.6.2 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="copyright" title="Copyright" href="../copyright.html" />
    <link rel="top" title="Python v2.6.2 documentation" href="../index.html" />
    <link rel="up" title="12. Data Persistence" href="persistence.html" />
    <link rel="next" title="12.7. whichdb — Guess which DBM module created a database" href="whichdb.html" />
    <link rel="prev" title="12.5. marshal — Internal Python object serialization" href="marshal.html" />
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 

  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="whichdb.html" title="12.7. whichdb — Guess which DBM module created a database"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="marshal.html" title="12.5. marshal — Internal Python object serialization"
             accesskey="P">previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">Python v2.6.2 documentation</a> &raquo;</li>

          <li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
          <li><a href="persistence.html" accesskey="U">12. Data Persistence</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-anydbm">
<h1>12.6. <tt class="xref docutils literal"><span class="pre">anydbm</span></tt> &#8212; Generic access to DBM-style databases<a class="headerlink" href="#module-anydbm" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <tt class="xref docutils literal"><span class="pre">anydbm</span></tt> module has been renamed to <a title="(Unix) The standard &quot;database&quot; interface, based on ndbm." class="reference external" href="dbm.html#module-dbm"><tt class="xref docutils literal"><span class="pre">dbm</span></tt></a> in Python 3.0.  The
<a class="reference external" href="../glossary.html#term-to3"><em class="xref">2to3</em></a> tool will automatically adapt imports when converting your
sources to 3.0.</p>
</div>
<p id="index-197"><tt class="xref docutils literal"><span class="pre">anydbm</span></tt> is a generic interface to variants of the DBM database &#8212;
<a title="DBM-style interface to the BSD database library." class="reference external" href="dbhash.html#module-dbhash"><tt class="xref docutils literal"><span class="pre">dbhash</span></tt></a> (requires <a title="Interface to Berkeley DB database library" class="reference external" href="bsddb.html#module-bsddb"><tt class="xref docutils literal"><span class="pre">bsddb</span></tt></a>), <a title="(Unix) GNU's reinterpretation of dbm." class="reference external" href="gdbm.html#module-gdbm"><tt class="xref docutils literal"><span class="pre">gdbm</span></tt></a>, or <a title="(Unix) The standard &quot;database&quot; interface, based on ndbm." class="reference external" href="dbm.html#module-dbm"><tt class="xref docutils literal"><span class="pre">dbm</span></tt></a>.  If none of
these modules is installed, the slow-but-simple implementation in module
<a title="Portable implementation of the simple DBM interface." class="reference external" href="dumbdbm.html#module-dumbdbm"><tt class="xref docutils literal"><span class="pre">dumbdbm</span></tt></a> will be used.</p>
<dl class="function">
<dt id="anydbm.open">
<tt class="descclassname">anydbm.</tt><tt class="descname">open</tt><big>(</big><em>filename</em><span class="optional">[</span>, <em>flag</em><span class="optional">[</span>, <em>mode</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#anydbm.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the database file <em>filename</em> and return a corresponding object.</p>
<p>If the database file already exists, the <a title="Guess which DBM-style module created a given database." class="reference external" href="whichdb.html#module-whichdb"><tt class="xref docutils literal"><span class="pre">whichdb</span></tt></a> module is  used to
determine its type and the appropriate module is used; if it does not exist, the
first module listed above that can be imported is used.</p>
<p>The optional <em>flag</em> argument can be <tt class="docutils literal"><span class="pre">'r'</span></tt> to open an existing database for
reading only, <tt class="docutils literal"><span class="pre">'w'</span></tt> to open an existing database for reading and writing,
<tt class="docutils literal"><span class="pre">'c'</span></tt> to create the database if it doesn&#8217;t exist, or <tt class="docutils literal"><span class="pre">'n'</span></tt>, which will
always create a new empty database.  If not specified, the default value is
<tt class="docutils literal"><span class="pre">'r'</span></tt>.</p>
<p>The optional <em>mode</em> argument is the Unix mode of the file, used only when the
database has to be created.  It defaults to octal <tt class="docutils literal"><span class="pre">0666</span></tt> (and will be modified
by the prevailing umask).</p>
</dd></dl>

<dl class="exception">
<dt id="anydbm.error">
<em class="property">
exception </em><tt class="descclassname">anydbm.</tt><tt class="descname">error</tt><a class="headerlink" href="#anydbm.error" title="Permalink to this definition">¶</a></dt>
<dd>A tuple containing the exceptions that can be raised by each of the supported
modules, with a unique exception also named <a title="anydbm.error" class="reference internal" href="#anydbm.error"><tt class="xref docutils literal"><span class="pre">anydbm.error</span></tt></a> as the first
item &#8212; the latter is used when <a title="anydbm.error" class="reference internal" href="#anydbm.error"><tt class="xref docutils literal"><span class="pre">anydbm.error</span></tt></a> is raised.</dd></dl>

<p>The object returned by <a title="open" class="reference external" href="functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a> supports most of the same functionality as
dictionaries; keys and their corresponding values can be stored, retrieved, and
deleted, and the <tt class="xref docutils literal"><span class="pre">has_key()</span></tt> and <tt class="xref docutils literal"><span class="pre">keys()</span></tt> methods are available.  Keys
and values must always be strings.</p>
<p>The following example records some hostnames and a corresponding title,  and
then prints out the contents of the database:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">anydbm</span>

<span class="c"># Open database, creating it if necessary.</span>
<span class="n">db</span> <span class="o">=</span> <span class="n">anydbm</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">&#39;cache&#39;</span><span class="p">,</span> <span class="s">&#39;c&#39;</span><span class="p">)</span>

<span class="c"># Record some values</span>
<span class="n">db</span><span class="p">[</span><span class="s">&#39;www.python.org&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;Python Website&#39;</span>
<span class="n">db</span><span class="p">[</span><span class="s">&#39;www.cnn.com&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;Cable News Network&#39;</span>

<span class="c"># Loop through contents.  Other dictionary methods</span>
<span class="c"># such as .keys(), .values() also work.</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">db</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
    <span class="k">print</span> <span class="n">k</span><span class="p">,</span> <span class="s">&#39;</span><span class="se">\t</span><span class="s">&#39;</span><span class="p">,</span> <span class="n">v</span>

<span class="c"># Storing a non-string key or value will raise an exception (most</span>
<span class="c"># likely a TypeError).</span>
<span class="n">db</span><span class="p">[</span><span class="s">&#39;www.yahoo.com&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">4</span>

<span class="c"># Close when done.</span>
<span class="n">db</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Module <a title="DBM-style interface to the BSD database library." class="reference external" href="dbhash.html#module-dbhash"><tt class="xref docutils literal"><span class="pre">dbhash</span></tt></a></dt>
<dd>BSD <tt class="docutils literal"><span class="pre">db</span></tt> database interface.</dd>
<dt>Module <a title="(Unix) The standard &quot;database&quot; interface, based on ndbm." class="reference external" href="dbm.html#module-dbm"><tt class="xref docutils literal"><span class="pre">dbm</span></tt></a></dt>
<dd>Standard Unix database interface.</dd>
<dt>Module <a title="Portable implementation of the simple DBM interface." class="reference external" href="dumbdbm.html#module-dumbdbm"><tt class="xref docutils literal"><span class="pre">dumbdbm</span></tt></a></dt>
<dd>Portable implementation of the <tt class="docutils literal"><span class="pre">dbm</span></tt> interface.</dd>
<dt>Module <a title="(Unix) GNU's reinterpretation of dbm." class="reference external" href="gdbm.html#module-gdbm"><tt class="xref docutils literal"><span class="pre">gdbm</span></tt></a></dt>
<dd>GNU database interface, based on the <tt class="docutils literal"><span class="pre">dbm</span></tt> interface.</dd>
<dt>Module <a title="Python object persistence." class="reference external" href="shelve.html#module-shelve"><tt class="xref docutils literal"><span class="pre">shelve</span></tt></a></dt>
<dd>General object persistence built on top of  the Python <tt class="docutils literal"><span class="pre">dbm</span></tt> interface.</dd>
<dt>Module <a title="Guess which DBM-style module created a given database." class="reference external" href="whichdb.html#module-whichdb"><tt class="xref docutils literal"><span class="pre">whichdb</span></tt></a></dt>
<dd>Utility module used to determine the type of an existing database.</dd>
</dl>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h4>Previous topic</h4>
            <p class="topless"><a href="marshal.html"
                                  title="previous chapter">12.5. <tt class="docutils literal"><span class="pre">marshal</span></tt> &#8212; Internal Python object serialization</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="whichdb.html"
                                  title="next chapter">12.7. <tt class="docutils literal"><span class="pre">whichdb</span></tt> &#8212; Guess which DBM module created a database</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../_sources/library/anydbm.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="../search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="whichdb.html" title="12.7. whichdb — Guess which DBM module created a database"
             >next</a> |</li>
        <li class="right" >
          <a href="marshal.html" title="12.5. marshal — Internal Python object serialization"
             >previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">Python v2.6.2 documentation</a> &raquo;</li>

          <li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
          <li><a href="persistence.html" >12. Data Persistence</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; <a href="../copyright.html">Copyright</a> 1990-2009, Python Software Foundation.
      Last updated on Apr 15, 2009.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
    </div>
  </body>
</html>